GET
Property Finder
https://www.microburbs.com.au/report_generator/api/property_finder
Search for properties based on multiple criteria including location, price, features, yield, growth, and proximity to amenities. Returns ranked results with match scores based on optional filters.
Contact for early access
Book a video call here: https://calendly.com/d/cvy2-vxt-3mt
Book a video call here: https://calendly.com/d/cvy2-vxt-3mt
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| suburbs | text | Optional | Comma-separated list of suburb (SAL) names. Either suburbs or regions is required. |
| regions | text | Optional | Comma-separated list of region names. Either suburbs or regions is required. |
| property_type | select | Optional | Type of property to search for |
| min_bedrooms | number | Optional | Minimum number of bedrooms |
| min_baths | number | Optional | Minimum number of bathrooms |
| min_cars | number | Optional | Minimum number of garage/car spaces |
| min_price | number | Optional | Minimum property price (default: 10,000) |
| max_price | number | Optional | Maximum property price |
| min_yield | number | Optional | Minimum rental yield percentage (e.g., 4.0 for 4%) |
| max_yield | number | Optional | Maximum rental yield percentage |
| min_growth | number | Optional | Minimum property growth percentage |
| max_growth | number | Optional | Maximum property growth percentage |
| min_growth_forecast | number | Optional | Minimum forecasted growth percentage |
| max_growth_forecast | number | Optional | Maximum forecasted growth percentage |
| min_distance_to_school | number | Optional | Minimum distance to nearest school (meters) |
| max_distance_to_school | number | Optional | Maximum distance to nearest school (meters, default: 2000) |
| min_distance_to_public_housing | number | Optional | Minimum distance to public housing (meters, default: 0) |
| max_distance_to_public_housing | number | Optional | Maximum distance to public housing (meters, default: 5000) |
| min_distance_to_supermarket | number | Optional | Minimum distance to nearest supermarket (meters) |
| max_distance_to_supermarket | number | Optional | Maximum distance to nearest supermarket (meters) |
| min_distance_to_park | number | Optional | Minimum distance to nearest park (meters) |
| max_distance_to_park | number | Optional | Maximum distance to nearest park (meters) |
| min_distance_to_beach | number | Optional | Minimum distance to nearest beach (meters) |
| max_distance_to_beach | number | Optional | Maximum distance to nearest beach (meters) |
| min_distance_to_railway | number | Optional | Minimum distance to nearest railway station (meters) |
| max_distance_to_railway | number | Optional | Maximum distance to nearest railway station (meters) |
| features | text | Optional | Comma-separated list of desired features (e.g., 'level_access,good_view_outlook,presence_of_ensuite,big_kitchen,presence_of_pool,entertaining_area,natural_light') |
| neighbors | boolean | Optional | Include neighboring suburbs in search (true/false, default: false) |
| sort_by | select | Optional | Column to sort results by |
| sort_direction | select | Optional | Sort direction (asc or desc, default: desc) |
| limit | number | Optional | Maximum number of results to return (default: 500, max: 5000) |
| offset | number | Optional | Number of results to skip for pagination (default: 0) |
Response Schema
| Field | Type | Description |
|---|---|---|
| success | boolean | Indicates if the request was successful |
| execution_time | number | Time taken to execute the query (in seconds) |
| total_properties | integer | Total number of properties matching the criteria |
| search_areas | array | List of searched suburbs or regions |
| search_type | string | Type of search performed ('sals' or 'regions') |
| sals_found | integer | Number of search areas found |
| properties | array | Array of matching properties |
| properties[].gnafId | string | GNAF property identifier |
| properties[].address | string | Full property address |
| properties[].street | string | Street address |
| properties[].suburb | string | Suburb name |
| properties[].state | string | State abbreviation |
| properties[].beds | integer | Number of bedrooms |
| properties[].bath | integer | Number of bathrooms |
| properties[].car | integer | Number of garage/car spaces |
| properties[].property_type | string | Type of property (house or unit) |
| properties[].price | number|string | Property price or 'N/A' if unavailable |
| properties[].price_f | string | Formatted price with thousand separators |
| properties[].sqm | string | Land size in square meters (formatted) |
| properties[].price_per_sqmt | number|string | Price per square meter or 'N/A' |
| properties[].yield | number|string | Rental yield percentage or 'N/A' |
| properties[].growth | number|string | Historical growth percentage or 'N/A' |
| properties[].growth_forecast | number|string | Forecasted growth percentage or 'N/A' |
| properties[].rental_income | number|string | Estimated weekly rental income or 'N/A' |
| properties[].score | number | Match percentage score (0-100) |
| properties[].match_percentage | number | Match percentage score (0-100, same as score) |
| properties[].latitude | number | Property latitude |
| properties[].longitude | number | Property longitude |
| properties[].listing_date | string|null | Property listing date (ISO format) |
| properties[].pros | array | List of property advantages based on search criteria |
| properties[].cons | array | List of property disadvantages based on search criteria |
| properties[].school_distance | number|string | Distance to nearest school (meters) or 'N/A' |
| properties[].public_housing_distance | number|string | Distance to public housing (meters) or 'N/A' |
| properties[].supermarket_distance | number|string | Distance to nearest supermarket (meters) or 'N/A' |
| properties[].park_distance | number|string | Distance to nearest park (meters) or 'N/A' |
| properties[].beach_distance | number|string | Distance to nearest beach (meters) or 'N/A' |
| properties[].railway_distance | number|string | Distance to nearest railway station (meters) or 'N/A' |
| properties[].level_access | string | 'true' or 'false' - property has level access |
| properties[].good_view_outlook | string | 'true' or 'false' - property has good views |
| properties[].presence_of_ensuite | string | 'true' or 'false' - property has ensuite |
| properties[].big_kitchen | string | 'true' or 'false' - property has large kitchen |
| properties[].presence_of_pool | string | 'true' or 'false' - property has pool |
| properties[].entertaining_area | string | 'true' or 'false' - property has entertaining area |
| properties[].natural_light | string | 'true' or 'false' - property has good natural light |
| properties[].ph | boolean | Public housing flag (always false) |
| features_enabled | object | System features status |
| features_enabled.region_based_search | boolean | Whether region-based search was used |
| features_enabled.caching_enabled | boolean | Whether caching is enabled |
| features_enabled.cache_age_hours | number|null | Age of cached data in hours |
| query_parameters | object | Echo of query parameters used |
| query_parameters.sals | array | List of suburbs searched |
| query_parameters.regions | array | List of regions searched |
| query_parameters.min_baths | number|null | Minimum bathrooms filter |
| query_parameters.min_bedrooms | number|null | Minimum bedrooms filter |
| query_parameters.min_cars | number|null | Minimum car spaces filter |
| query_parameters.min_price | number|null | Minimum price filter |
| query_parameters.max_price | number|null | Maximum price filter |
| query_parameters.min_distance_to_public_housing | number|null | Minimum public housing distance filter |
| query_parameters.max_distance_to_public_housing | number|null | Maximum public housing distance filter |
| query_parameters.min_distance_to_school | number|null | Minimum school distance filter |
| query_parameters.max_distance_to_school | number|null | Maximum school distance filter |
| query_parameters.min_yield | number|null | Minimum yield filter |
| query_parameters.max_yield | number|null | Maximum yield filter |
| query_parameters.publi_housing_value_thresh | number | Public housing threshold value |
| query_parameters.buffer_expansion | number | Buffer expansion value |
| query_parameters.limit | integer | Results limit |
| query_parameters.offset | integer | Results offset |
| query_parameters.use_regions | boolean | Whether region-based search was used |
| query_parameters.property_type | string|null | Property type filter |
| query_parameters.sort_by | string|null | Sort column |
| query_parameters.sort_direction | string | Sort direction |
Request Examples
cURL
Python
JavaScript
curl -X GET "https://www.microburbs.com.au/report_generator/api/property_finder?suburb=Belmont%20North" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"
Response Example
Response
{
"success": true,
"execution_time": 0.523,
"total_properties": 147,
"search_areas": ["Belmont North"],
"search_type": "sals",
"sals_found": 1,
"properties": [
{
"gnafId": "GAVIC411234567",
"address": "123 Beach Street, Belmont North VIC 3199",
"street": "123 Beach Street",
"suburb": "Belmont North",
"state": "VIC",
"beds": 3,
"bath": 2,
"car": 2,
"property_type": "house",
"price": 650000,
"price_f": "650,000",
"sqm": "450",
"price_per_sqmt": 1444.44,
"yield": 4.8,
"growth": 5.2,
"growth_forecast": 3.5,
"rental_income": 600,
"score": 85,
"match_percentage": 85,
"latitude": -38.1421,
"longitude": 145.1234,
"listing_date": "2024-11-15T00:00:00",
"pros": [
"Close to schools (850m)",
"Near beach (1.2km)",
"Good rental yield (4.8%)"
],
"cons": [
"Further from railway station (2.5km)"
],
"school_distance": 850,
"public_housing_distance": 3200,
"supermarket_distance": 450,
"park_distance": 200,
"beach_distance": 1200,
"railway_distance": 2500,
"level_access": "true",
"good_view_outlook": "false",
"presence_of_ensuite": "true",
"big_kitchen": "true",
"presence_of_pool": "false",
"entertaining_area": "true",
"natural_light": "true",
"ph": false
}
],
"features_enabled": {
"region_based_search": false,
"caching_enabled": true,
"cache_age_hours": 2.5
},
"query_parameters": {
"sals": ["Belmont North"],
"regions": [],
"min_baths": null,
"min_bedrooms": null,
"min_cars": null,
"min_price": 10000,
"max_price": null,
"min_distance_to_public_housing": null,
"max_distance_to_public_housing": null,
"min_distance_to_school": null,
"max_distance_to_school": null,
"min_yield": null,
"max_yield": null,
"publi_housing_value_thresh": 0.07,
"buffer_expansion": 50000,
"limit": 500,
"offset": 0,
"use_regions": false,
"sort_by": null,
"sort_direction": "desc",
"property_type": "house"
}
}